<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Livox SDK API: livox::CommPort Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="1.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Livox SDK API
   &#160;<span id="projectnumber">V2.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classlivox_1_1_comm_port.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classlivox_1_1_comm_port-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">livox::CommPort Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="comm__port_8h_source.html">comm_port.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5a159a37a2b90e3e99a8a2258494c374"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_comm_port.html#a5a159a37a2b90e3e99a8a2258494c374">CommPort</a> ()</td></tr>
<tr class="separator:a5a159a37a2b90e3e99a8a2258494c374"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12578479c9799e0e1019e5698841072b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_comm_port.html#a12578479c9799e0e1019e5698841072b">~CommPort</a> ()</td></tr>
<tr class="separator:a12578479c9799e0e1019e5698841072b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa06a75c5c7801967271b8925bd734fd1"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_comm_port.html#aa06a75c5c7801967271b8925bd734fd1">Pack</a> (uint8_t *o_buf, uint32_t o_buf_size, uint32_t *o_len, const <a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a> &amp;i_packet)</td></tr>
<tr class="separator:aa06a75c5c7801967271b8925bd734fd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0747279cfee5e49d6abe399adbe81e2a"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_comm_port.html#a0747279cfee5e49d6abe399adbe81e2a">ParseCommStream</a> (<a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a> *o_pack)</td></tr>
<tr class="separator:a0747279cfee5e49d6abe399adbe81e2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb44afd20231d53d38f477e4b5861711"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_comm_port.html#abb44afd20231d53d38f477e4b5861711">FetchCacheFreeSpace</a> (uint32_t *o_len)</td></tr>
<tr class="separator:abb44afd20231d53d38f477e4b5861711"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab520a4434c8e19868cf3bab6c229ab7d"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_comm_port.html#ab520a4434c8e19868cf3bab6c229ab7d">UpdateCacheWrIdx</a> (uint32_t used_size)</td></tr>
<tr class="separator:ab520a4434c8e19868cf3bab6c229ab7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a921c62e412bfa973effc62d2592eb2ac"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlivox_1_1_comm_port.html#a921c62e412bfa973effc62d2592eb2ac">GetAndUpdateSeqNum</a> ()</td></tr>
<tr class="separator:a921c62e412bfa973effc62d2592eb2ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="comm__port_8h_source.html#l00042">42</a> of file <a class="el" href="comm__port_8h_source.html">comm_port.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5a159a37a2b90e3e99a8a2258494c374"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a159a37a2b90e3e99a8a2258494c374">&#9670;&nbsp;</a></span>CommPort()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">livox::CommPort::CommPort </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a12578479c9799e0e1019e5698841072b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12578479c9799e0e1019e5698841072b">&#9670;&nbsp;</a></span>~CommPort()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">livox::CommPort::~CommPort </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abb44afd20231d53d38f477e4b5861711"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb44afd20231d53d38f477e4b5861711">&#9670;&nbsp;</a></span>FetchCacheFreeSpace()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t* livox::CommPort::FetchCacheFreeSpace </td>
          <td>(</td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>o_len</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a921c62e412bfa973effc62d2592eb2ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a921c62e412bfa973effc62d2592eb2ac">&#9670;&nbsp;</a></span>GetAndUpdateSeqNum()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t livox::CommPort::GetAndUpdateSeqNum </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="aa06a75c5c7801967271b8925bd734fd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa06a75c5c7801967271b8925bd734fd1">&#9670;&nbsp;</a></span>Pack()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t livox::CommPort::Pack </td>
          <td>(</td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>o_buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>o_buf_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>o_len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a> &amp;&#160;</td>
          <td class="paramname"><em>i_packet</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a0747279cfee5e49d6abe399adbe81e2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0747279cfee5e49d6abe399adbe81e2a">&#9670;&nbsp;</a></span>ParseCommStream()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t livox::CommPort::ParseCommStream </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structlivox_1_1_comm_packet.html">CommPacket</a> *&#160;</td>
          <td class="paramname"><em>o_pack</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ab520a4434c8e19868cf3bab6c229ab7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab520a4434c8e19868cf3bab6c229ab7d">&#9670;&nbsp;</a></span>UpdateCacheWrIdx()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t livox::CommPort::UpdateCacheWrIdx </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>used_size</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>sdk_core/include/comm/<a class="el" href="comm__port_8h_source.html">comm_port.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespacelivox.html">livox</a></li><li class="navelem"><a class="el" href="classlivox_1_1_comm_port.html">CommPort</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
  </ul>
</div>
</body>
</html>
